Summary
Includes multiple documents.
Category | AS Document |
Version | 1.0 |
Complies with Xhtml 1.0 / 1.1 rules | Yes |
Supported server programming languages | C# Visual Basic.NET |
Output content type | block |
When to use
This component is typically used when there is a need to include a list of documents.
Programming interface
Parameters
- Location
- A category where the document to include are located
- Wrap between documents
- Creates an wordwrap between each included documents
- Number
- The number of documents you want to include . Use zero (0) to include all documents in the current category
- Start index
- Defines what document in the sort order to start including from. 0 is the first document.
- Sort order
- A integer value that indicates the sort order of the included documents.
-
Accepable values are:
- 0 - Date
- 1 - Title
- Presentation template
- An optional presentation template for each documents to be included. Useful only if the document included are EPT documents.
- Owner documents
- Inserts only documents created by the owner of current document
- Root owner
- Check this If you want to use the owner of the root document (the id in querystring).
- Table properties
- Insert the documents in a table element
- Include the documents into a Html TABLE element.
- Border
- A value that indicates the border of the generated table.
- Cellpadding
- A value that indicates the cellpadding to use with the generated table.
- Cellspacing
- A value that indicates the cellspacing to use with the generated table.
- Width
- A value that defines the width attribute of the generated table
- Caption
- The caption element connected to the the generated table. The default value is an empty string which omits the element. Omitting this element causes xhtml 1.0 strict or higher validators to generate a warning.
- Summary
- The summary attribute of the generated table. The default value is an empty string which omits the attribute. Omitting this attribute causes xhtml 1.0 strict or higher validators to generate a warning.
- RowColor1
- The colour of un-even lines in the table
- RowColor2
- The colour of even lines in the table
- NoRecordText
- A text to be displayed if no documents are inserted.
- Check caller's permission
- Indicates that an check for the BROWSE permission is performed on each inserted document. Set this parameter to false for better performance
- Cache methods
-
- No cache
-
Use application cache
Cache the result of a previous document retrieval operation. Should not be used in an intranet where security permissions is important for what documents are found.
- Application cache timeout
- Timeout in minutes for application cache, 0 = no timeout
- Check for read permission
- Tells if the component chould check for read permission instead of browse.
Remarks
The included documents or their presentation templates must not contain meta data.